<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.obj._object._Object</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.obj-module.html">Package&nbsp;obj</a> ::
        <a href="py2ecotect.obj._object-module.html" onclick="show_private();">Module&nbsp;_object</a> ::
        Class&nbsp;_Object
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.obj._object._Object-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class _Object</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">_Object</strong>
</pre>

<dl><dt>Known Subclasses:</dt>
<dd>
      <ul class="subclass-list">
<li><a href="py2ecotect.obj._object.Appliance-class.html">Appliance</a></li><li>, <a href="py2ecotect.obj._object.Appliance-class.html">Appliance</a></li><li>, <a href="py2ecotect.obj._object.Camera-class.html">Camera</a></li><li>, <a href="py2ecotect.obj._object.Camera-class.html">Camera</a></li><li>, <a href="py2ecotect.obj._object.Ceiling-class.html">Ceiling</a></li><li>, <a href="py2ecotect.obj._object.Ceiling-class.html">Ceiling</a></li><li>, <a href="py2ecotect.obj._object.Door-class.html">Door</a></li><li>, <a href="py2ecotect.obj._object.Door-class.html">Door</a></li><li>, <a href="py2ecotect.obj._object.Floor-class.html">Floor</a></li><li>, <a href="py2ecotect.obj._object.Floor-class.html">Floor</a></li><li>, <a href="py2ecotect.obj._object.Light-class.html">Light</a></li><li>, <a href="py2ecotect.obj._object.Light-class.html">Light</a></li><li>, <a href="py2ecotect.obj._object.Line-class.html">Line</a></li><li>, <a href="py2ecotect.obj._object.Line-class.html">Line</a></li><li>, <a href="py2ecotect.obj._object.Panel-class.html">Panel</a></li><li>, <a href="py2ecotect.obj._object.Panel-class.html">Panel</a></li><li>, <a href="py2ecotect.obj._object.Partition-class.html">Partition</a></li><li>, <a href="py2ecotect.obj._object.Partition-class.html">Partition</a></li><li>, <a href="py2ecotect.obj._object.Point-class.html">Point</a></li><li>, <a href="py2ecotect.obj._object.Point-class.html">Point</a></li><li>, <a href="py2ecotect.obj._object.Roof-class.html">Roof</a></li><li>, <a href="py2ecotect.obj._object.Roof-class.html">Roof</a></li><li>, <a href="py2ecotect.obj._object.SolarCollector-class.html">SolarCollector</a></li><li>, <a href="py2ecotect.obj._object.SolarCollector-class.html">SolarCollector</a></li><li>, <a href="py2ecotect.obj._object.Speaker-class.html">Speaker</a></li><li>, <a href="py2ecotect.obj._object.Speaker-class.html">Speaker</a></li><li>, <a href="py2ecotect.obj._object.Void-class.html">Void</a></li><li>, <a href="py2ecotect.obj._object.Void-class.html">Void</a></li><li>, <a href="py2ecotect.obj._object.Wall-class.html">Wall</a></li><li>, <a href="py2ecotect.obj._object.Wall-class.html">Wall</a></li><li>, <a href="py2ecotect.obj._object.Window-class.html">Window</a></li><li>, <a href="py2ecotect.obj._object.Window-class.html">Window</a></li>  </ul>
</dd></dl>

<hr />
<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Nested Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-NestedClasses"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.child-class.html" class="summary-name">child</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.func-class.html" class="summary-name">func</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.modf-class.html" class="summary-name">modf</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.mtrl-class.html" class="summary-name">mtrl</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.node-class.html" class="summary-name">node</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.prop-class.html" class="summary-name">prop</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.state-class.html" class="summary-name">state</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.trfm-class.html" class="summary-name">trfm</a>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object.dupl-class.html" class="summary-name">dupl</a>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">object_eco_id</span>,
        <span class="summary-sig-arg">points</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
      This command removes the specified object from the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#done" class="summary-sig-name">done</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Call this method to complete a new object after you have used the 
      add.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.done">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#extrude" class="summary-sig-name">extrude</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">extrude_distance</span>)</span><br />
      Extrudes the specified object a distance of x, y and z in the major 
      axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.extrude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#revolve" class="summary-sig-name">revolve</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">axis</span>,
        <span class="summary-sig-arg">angle</span>,
        <span class="summary-sig-arg">segs</span>)</span><br />
      Revolves the specified object around the Transformation Origin to 
      create a 3D volume.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.revolve">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#get_activation" class="summary-sig-name">get_activation</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">day</span>,
        <span class="summary-sig-arg">hour</span>)</span><br />
      Returns the fractional activation value of the specified object for 
      the given day and hour.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.get_activation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#get_coplanar" class="summary-sig-name">get_coplanar</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>)</span><br />
      Determines if a point is co-planar with the specified object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.get_coplanar">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS METHODS ==================== -->
<a name="section-ClassMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.obj._object._Object-class.html#_gen_object" class="summary-sig-name" onclick="show_private();">_gen_object</a>(<span class="summary-sig-arg">cls</span>,
        <span class="summary-sig-arg">elemType</span>,
        <span class="summary-sig-arg">objType</span>,
        <span class="summary-sig-arg">selected</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">link</span>=<span class="summary-sig-default">0</span>)</span><br />
      Use this command to create new objects in the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object._gen_object">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object-class.html#eco_id" class="summary-name">eco_id</a><br />
      Id of the object
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.obj._object._Object-class.html#zone" class="summary-name">zone</a><br />
      Retrieves the zone index of the specified object.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">object_eco_id</span>,
        <span class="sig-arg">points</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_gen_object"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_gen_object</span>(<span class="sig-arg">cls</span>,
        <span class="sig-arg">elemType</span>,
        <span class="sig-arg">objType</span>,
        <span class="sig-arg">selected</span>=<span class="sig-default">True</span>,
        <span class="sig-arg">link</span>=<span class="sig-default">0</span>)</span>
    <br /><em class="fname">Class Method</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object._gen_object">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to create new objects in the model. It returns the 
  zero-based index of the object just added which you can then use to add 
  nodes.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>elemType The element type of the new object and may be given as either
  a token or value as shown in the Element Types table below.</p>
  <p>objType The type of object to be created and may be given as either a 
  token or value corresponding with the following Object Types table.</p>
  <p>[selected] This optional parameter determines whether the newly 
  created object is set as selected. This is a boolean value where 1 or 
  true represents the affirmative and 0 or false the negative. If not 
  specified, this parameter defaults to true.</p>
  <p>[link] If the objtype is set to child, this optional parameter 
  specifies what type of object the child is linked with. The [link] value 
  can be selected from the same table for the elemType parameter.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>objectIndex The zero-based index of the object just added. A value of 
  -1 indicates that the operation failed.</p>
  <p>Relevant Data Table(s)</p>
  <p>Element Types Token Value void 0 roof 1 floor 2 ceiling 3 wall 4 
  partition 5 window 6 panel 7 door 8 point 9 speaker 10 light 11 appliance
  12 line 13 solarcollector 14 camera 15</p>
  <p>Object Type Codes Token  Value point 1 vector 2 plane 12 wall 32 zone 
  4140 source 3 child 2444</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command removes the specified object from the model. Note that 
  this will reduce the number of objects in the model so, if you are 
  cycling through all model objects in a loop, make sure you decrement the 
  overall object count accordingly. Alternatively, you could start from the
  last object and delete backwards through the list.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="done"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">done</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.done">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Call this method to complete a new object after you have used the add.
  object and add.node commands to generate it. This command tells ECOTECT 
  to check the object's validity, calculate its plane equation and surface 
  area (if required) and exit the interactive add node mode.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="extrude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">extrude</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">extrude_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.extrude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Extrudes the specified object a distance of x, y and z in the major 
  axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>extrude_distance A list of three values that specifies a distance to 
  extrude the specified object in each of the major axes.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="revolve"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">revolve</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">axis</span>,
        <span class="sig-arg">angle</span>,
        <span class="sig-arg">segs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.revolve">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Revolves the specified object around the Transformation Origin to 
  create a 3D volume. See the object.rotate command for more information on
  specifying the Transformation Origin.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>axis The axis for the revolve, and is an integer selected from the 
  Axis table.</p>
  <p>angle The revolve angle, given in degrees from 0 to 360.</p>
  <p>segs The number of angular segments to use for the revolve. The 
  greater the number of segments, the 'smoother' the reolved object. 
  However, this will also increase the geometric complexity of the revolved
  object.</p>
  <p>Relevant Data Table(s)</p>
  <p>Axis Types Value Description 0 Around the Z axis. 1 Around the X axis.
  2 Around the Y axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_activation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_activation</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">day</span>,
        <span class="sig-arg">hour</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.get_activation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the fractional activation value of the specified object for 
  the given day and hour. This will be a value between 0 - 1, where 0 is 
  off and 1 is on.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>day The julian date, given as an integer between 1 and 365.</p>
  <p>hour The hour of the day and must be an integer between 0 and 23, 
  where 0 is midnight on the previous day and 23 is 11:00pm on the given 
  day.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>activation The fractional activation value of the specified object for
  the given day and hour. This will be a value between 0 - 1, where 0 is 
  off and 1 is on.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_coplanar"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_coplanar</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.obj._object-pysrc.html#_Object.get_coplanar">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Determines if a point is co-planar with the specified object. 
  Obviously this only works with objects that are closed planar 
  surfaces.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represents the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>colanar A boolean value where 1 means that the point is coplanar and 0
  means that it isn't.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="eco_id"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">eco_id</h3>
  <p>Id of the object</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Id of the object
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="zone"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">zone</h3>
  <p>Retrieves the zone index of the specified object. The value returned 
  corresponds with the numerical order of the zone in the Zone Management 
  Panel. For example, if the specified object is part of the second zone in
  the Zone Management panel, the value returned will be 2. The Outside zone
  is always 0.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>link The zero-based index of the zone the specified object is assigned
  to.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the zone index of the specified object.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span>
        - Sets the specified object as a zone of the given index.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:48 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
